SKIN Root Element

Description

Root element for the skin. This element is mandatory for the skin to be valid. It describes the skin meta data and main window properties. It inherits properties from cell element: it is the root cell of the window.

Common Attributes

See cell element.

Specific Attributes
Name Value Type Default Value Description Comment V. Exp.

name

string

empty

Name of the skin.


1.0

No

author

string

empty

Author of the skin. Will be displayed in the about box.


1.0

No

comment

string

empty

Comment of the author about the skin (description, copyright...)


1.0

No

language_version

version info

empty

Version of the language used for the skin

This value is important to specify which version of the skinning language is expected by the skin designer.

1.0

No

background_image

valid image file path

empty

The background image.


1.0

No

repeat

boolean

false

Enables or disables the repetition of the background image.

If set to 'true' and if a background image has been set, it will be repeated to cover the whole skin surface.

1.0

No

background_color

color

#000000 (black)

Color used to paint the background of the skin.

This attribute is not used if 'background_image' is defined.

1.0

No

show_warnings

boolean

true

Show warnings encountered during skin parsing.


1.0

No

show_info

boolean

false

Show information about skin parsing process.

Can be useful to find issues in your skin when designing it. You should never release to the end suer a skin with this attribute set to true.

1.0

No

refresh_time_ms

Positive integer

50

default refresh rate (expressed as a period) in the user interface for the plugin parameters and curves.

Use this parameter is you have a very complex user interface with output parameters and curves that refresh too often. Setting the refresh_time_ms to a higher value will help you minimize CPU usage.

1.1

No

xxx_refresh_time_ms, where xxx is a param id or curve id

Positive integer

50

refresh rate (expressed as a period) in the user interface for the plugin parameter or curve corresponding to xxx.

Use this parameter to specify the refresh rate on a specific parameter or curve.

1.1

No

refresh_priority

'idle' or 'normal'

idle

priority for user interface refreshs.

The higher the priority, the softer the user interface will respond to changes but the more CPU it will use.

1.4.3

No

window.opacity

percentage

100%

Opacity of the top-level window containing the skin.

Use this parameter to specify the opacity of the top level window containing the skin.

Warning: this option may work differently depending on the host application.

1.2.5

1.2.5

Examples

Empty skin with black background (minimum size of a skin is 20x20 pixels, so that the user can click on the background to change the skin)

<?xml version="1.0" encoding="utf-8" ?>
<SKIN background_color="#000000" author="Blue Cat Audio" language_version="1.0"/>

Empty skin with 'bg.bmp' image as background:

<?xml version="1.0" encoding="utf-8" ?>
<SKIN background_image="bg.bmp" author="Blue Cat Audio" language_version="1.0">
</SKIN>

Skin with 'bg.bmp' image as background (repeated), with 5 images (black square) shown in a row, spaced by 5 pixels:

<?xml version="1.0" encoding="utf-8" ?>
<SKIN author="Blue Cat Audio" name="Skin with Bg" language_version="1.0" background_image="bg.bmp"
   repeat="true" layout_type="row" h_margin="5" v_margin="10" spacing="5">
   <IMAGE image="black_square.bmp" />
   <IMAGE image="black_square.bmp" />
   <IMAGE image="black_square.bmp" />
   <IMAGE image="black_square.bmp" />
   <IMAGE image="black_square.bmp" />
   <IMAGE image="black_square.bmp" />
</SKIN>